<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>Test Before Reference - TB</title>

        <link rel="stylesheet" href="../static/blue.css" type="text/css" media="screen" charset="utf-8" />
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

        

<!-- ============================== classes index ============================ -->
		<div id="index">
            <div id="docs">
                
            </div>
			
<h2>Index</h2>
<ul class="classList">
  <li><a href="../files.html">File Index</a></li>
  <li><a href="../index.html">Class Index</a></li>
  <li><a href="../symbolindex.html">Symbol Index</a></li>
</ul>
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/formatter.html">formatter</a></li>
	
	<li><a href="../symbols/Module.html">Module</a></li>
	
	<li><a href="../symbols/TB.html">TB</a></li>
	
	<li><a href="../symbols/Test.html">Test</a></li>
	
</ul>

		</div>
		
        <!--
        <div id="symbolList">
           <!-- constructor list -->
           
             <h3>
                 Namespace 
             </h3>
             <ul>
                <li >
                  <a href="../symbols/TB.html">TB</a>
                </li>
             </ul>
           
           <!-- end constructor list -->

           <!-- properties list -->
           
           
           <!-- end properties list -->

           <!-- function summary -->
           
           
             <h3>Functions</h3>
             <ul>
               
                   <li>
                        <a href="../symbols/TB.html#-assertion">assertion</a>
                    </li>
               
                   <li>
                        <a href="../symbols/TB.html#.deepEqual">deepEqual</a>
                    </li>
               
                   <li>
                        <a href="../symbols/TB.html#.defined">defined</a>
                    </li>
               
                   <li>
                        <a href="../symbols/TB.html#.equal">equal</a>
                    </li>
               
                   <li>
                        <a href="../symbols/TB.html#.hasProperty">hasProperty</a>
                    </li>
               
                   <li>
                        <a href="../symbols/TB.html#.notDeepEqual">notDeepEqual</a>
                    </li>
               
                   <li>
                        <a href="../symbols/TB.html#.notEqual">notEqual</a>
                    </li>
               
                   <li>
                        <a href="../symbols/TB.html#.objectType">objectType</a>
                    </li>
               
                   <li>
                        <a href="../symbols/TB.html#.ok">ok</a>
                    </li>
               
                   <li>
                        <a href="../symbols/TB.html#.strictEqual">strictEqual</a>
                    </li>
               
                   <li>
                        <a href="../symbols/TB.html#.strictNotEqual">strictNotEqual</a>
                    </li>
               
             </ul>
           
           <!-- end function summary -->

           <!-- events summary -->
           
           
           <!-- end events summary -->
        </div>
        -->
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				Namespace TB
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				<br />Version
					0.1.0 dev.<br />
				
				
			
				
				
				
					<p class="definedIn">Defined in: <a href="../symbols/src/_Users_collinbrooks_Dropbox_Scripts_AEScripts_BeforeEffects_src_testbefore.jsxinc.html">testbefore.jsxinc</a>.</p>
				
			</p>

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>
				
				<div class="fixedFont">
						<b>TB</b>
				</div>
				
				<div class="description">
					<p>The main testbefore object.</p>
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
              <div class="details">
				<div class="sectionTitle">
					Method Detail
				</div>
				
                  <div class="member">
					<a name="-assertion"> </a>
					<div class="fixedFont">
                      <div class="modifiers">&lt;private&gt; &lt;inner&gt; 
                      </div>
					<span class="light">{Object}</span>
					<b>assertion</b>(result, actual, expected, message)
					
					</div>
					<div class="description">
						<p>Returns an object with a result and message that describes information
about the test.</p>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Bool}</span> <b>result</b>
									
								</dt>
								<dd>The boolean result for the given test.</dd>
							
								<dt>
									<span class="light fixedFont">{*}</span> <b>actual</b>
									
								</dt>
								<dd>The actual value of the test.</dd>
							
								<dt>
									<span class="light fixedFont">{*}</span> <b>expected</b>
									
								</dt>
								<dd>The expected value of the test.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>message</b>
									
								</dt>
								<dd>The message to display next to this test result.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Object}</span> An object with result and message keys. The result is
a boolean value and the message is a string.</dd>
							
							</dl>
						
						
						

                  </div>
				
                  <div class="member">
					<a name=".deepEqual"> </a>
					<div class="fixedFont">
                      <div class="modifiers">&lt;static&gt; 
                      </div>
					
					<span class="light">TB.</span><b>deepEqual</b>(The, The, message)
					
					</div>
					<div class="description">
						<p>A deep recursive comparison assertion, working on primitive types,
arrays and objects. Similar to equal, compares the content given
objects. Its also more strict than equal: Comparisons are done using
===.  For a discussion of the concepts and reasons behind the
implementation, see <a href="http://philrathe.com/articles/equiv">this
article</a>.</p>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>The</b>
									
								</dt>
								<dd>object that is the actual resulting object of the
assertion.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>The</b>
									
								</dt>
								<dd>object that is the expected resulting object of the
assertion.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>message</b>
									
								</dt>
								<dd>The message to display with the assertion.</dd>
							
							</dl>
						
						
						
						
						
						
						

                  </div>
				
                  <div class="member">
					<a name=".defined"> </a>
					<div class="fixedFont">
                      <div class="modifiers">&lt;static&gt; 
                      </div>
					
					<span class="light">TB.</span><b>defined</b>(test, message)
					
					</div>
					<div class="description">
						<p>Asserts that a given object is defined.</p>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{*}</span> <b>test</b>
									
								</dt>
								<dd>The value to test as being defined.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>message</b>
									
								</dt>
								<dd>The message to display with this assertion.</dd>
							
							</dl>
						
						
						
						
						
						
						

                  </div>
				
                  <div class="member">
					<a name=".equal"> </a>
					<div class="fixedFont">
                      <div class="modifiers">&lt;static&gt; 
                      </div>
					
					<span class="light">TB.</span><b>equal</b>(actual, expected, message)
					
					</div>
					<div class="description">
						<p>Checks that the first two arguments are equal.
Prints out both actual and expected values.</p>

<p>Prefered to ok( actual == expected, message )</p>

<p>NOTE: This method uses a relaxed comparison (==), for a more strict
comparison, see <a href="../symbols/TB.html#.strictEqual">TB.strictEqual</a></p>
						
						
					</div>
					
					
					
					<pre class="code">TB.equal(format("Received {0} bytes.", 2), "Received 2
bytes.");</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>actual</b>
									
								</dt>
								<dd>The actual value of the assertion.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>expected</b>
									
								</dt>
								<dd>The expected value of the assertion.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>message</b>
									<i>Optional</i>
								</dt>
								<dd>The message to be displayed for this
assertion.</dd>
							
							</dl>
						
						
						
						
						
						
						

                  </div>
				
                  <div class="member">
					<a name=".hasProperty"> </a>
					<div class="fixedFont">
                      <div class="modifiers">&lt;static&gt; 
                      </div>
					
					<span class="light">TB.</span><b>hasProperty</b>(The, The, message)
					
					</div>
					<div class="description">
						<p>Asserts that a given object has a method or field with the given
property name.</p>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>The</b>
									
								</dt>
								<dd>object to check for a property.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>The</b>
									
								</dt>
								<dd>string name representation of the method or field to
search the given Object for.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>message</b>
									
								</dt>
								<dd>The message to display with this assertion.</dd>
							
							</dl>
						
						
						
						
						
						
						

                  </div>
				
                  <div class="member">
					<a name=".notDeepEqual"> </a>
					<div class="fixedFont">
                      <div class="modifiers">&lt;static&gt; 
                      </div>
					
					<span class="light">TB.</span><b>notDeepEqual</b>(The, The, message)
					
					</div>
					<div class="description">
						<p>A deep recursive comparison assertion, working on primitive types,
arrays and objects. Similar to notEqual, compares the content given
objects. Its also more strict than notEqual: Comparisons are done using
===.  For a discussion of the concepts and reasons behind the
implementation, see <a href="http://philrathe.com/articles/equiv">this
article</a>.</p>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>The</b>
									
								</dt>
								<dd>object that is the actual resulting object of the
assertion.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>The</b>
									
								</dt>
								<dd>object that is the expected resulting object of the
assertion.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>message</b>
									
								</dt>
								<dd>The message to display with the assertion.</dd>
							
							</dl>
						
						
						
						
						
						
						

                  </div>
				
                  <div class="member">
					<a name=".notEqual"> </a>
					<div class="fixedFont">
                      <div class="modifiers">&lt;static&gt; 
                      </div>
					
					<span class="light">TB.</span><b>notEqual</b>(actual, expected, message)
					
					</div>
					<div class="description">
						<p>Checks that the first two arguments are not equal.
Prints out both actual and expected values.</p>

<p>Prefered to ok(actual != expected, message)</p>

<p>NOTE: This method uses a relaxed comparison (==), for a more strict
comparison, see (@link TB.strictNotEqual}</p>
						
						
					</div>
					
					
					
					<pre class="code">TB.notEqual(format("Received {0} bytes.", 2), "Received 2
bytes.");</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>actual</b>
									
								</dt>
								<dd>The actual value of the assertion.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>expected</b>
									
								</dt>
								<dd>The expected value of the assertion.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>message</b>
									<i>Optional</i>
								</dt>
								<dd>The message to be displayed for this
assertion.</dd>
							
							</dl>
						
						
						
						
						
						
						

                  </div>
				
                  <div class="member">
					<a name=".objectType"> </a>
					<div class="fixedFont">
                      <div class="modifiers">&lt;static&gt; 
                      </div>
					<span class="light">{String}</span>
					<span class="light">TB.</span><b>objectType</b>(obj)
					
					</div>
					<div class="description">
						<p>Returns the type of the given object as a lowercase string.
Borrowed from QUnit: http://docs.jquery.com/QUnit</p>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>obj</b>
									
								</dt>
								<dd>An object to get the type of.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> A lowercase type string.</dd>
							
							</dl>
						
						
						

                  </div>
				
                  <div class="member">
					<a name=".ok"> </a>
					<div class="fixedFont">
                      <div class="modifiers">&lt;static&gt; 
                      </div>
					
					<span class="light">TB.</span><b>ok</b>(actual, message)
					
					</div>
					<div class="description">
						<p>Asserts true.</p>
						
						
					</div>
					
					
					
					<pre class="code">ok( "asdfasdf".length > 5, "There must be at least 5 chars" );</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>actual</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<b>message</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

                  </div>
				
                  <div class="member">
					<a name=".strictEqual"> </a>
					<div class="fixedFont">
                      <div class="modifiers">&lt;static&gt; 
                      </div>
					
					<span class="light">TB.</span><b>strictEqual</b>(actual, expected, message)
					
					</div>
					<div class="description">
						<p>Strictly checks that the first two arguments are equal.
Prints out both actual and expected values.</p>

<p>Prefered to ok( actual === expected, message )</p>

<p>NOTE: This method uses a strict comparison (===), for a more relaxed
comparison, see <a href="../symbols/TB.html#.equal">TB.equal</a></p>
						
						
					</div>
					
					
					
					<pre class="code">TB.strictEqual(format("Received {0} bytes.", 2), "Received 2
bytes.");</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>actual</b>
									
								</dt>
								<dd>The actual value of the assertion.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>expected</b>
									
								</dt>
								<dd>The expected value of the assertion.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>message</b>
									<i>Optional</i>
								</dt>
								<dd>The message to be displayed for this
assertion.</dd>
							
							</dl>
						
						
						
						
						
						
						

                  </div>
				
                  <div class="member">
					<a name=".strictNotEqual"> </a>
					<div class="fixedFont">
                      <div class="modifiers">&lt;static&gt; 
                      </div>
					
					<span class="light">TB.</span><b>strictNotEqual</b>(actual, expected, message)
					
					</div>
					<div class="description">
						<p>Strictly checks that the first two arguments are not equal.
Prints out both actual and expected values.</p>

<p>Prefered to ok(actual !== expected, message)</p>

<p>NOTE: This method uses a strict comparison (===), for a more relaxed
comparison, see (@link TB.notEqual}</p>
						
						
					</div>
					
					
					
					<pre class="code">TB.strictNotEqual(format("Received {0} bytes.", 2), "Received 2
bytes.");</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>actual</b>
									
								</dt>
								<dd>The actual value of the assertion.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>expected</b>
									
								</dt>
								<dd>The expected value of the assertion.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>message</b>
									<i>Optional</i>
								</dt>
								<dd>The message to be displayed for this
assertion.</dd>
							
							</dl>
						
						
						
						
						
						
						

                  </div>
				
              </div>
			
			
<!-- ============================== event details ========================= -->		
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both;text-align:center">
			&copy;2011<br />
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Fri Sep 16 2011 20:12:35 GMT-0500 (CDT)
		</div>
	</body>
</html>
